chore: drop alpha warnings and stay on prerelease version - #8
Conversation
Bumps the SDK to 1.0.0 and drops all alpha-specific guidance now that the API is stable for general availability. Removes the alpha status badge, warning block, and --pre install instructions from the docs so users can install the package normally. RUNNER-9680
c2a8da5 to
d6fbace
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
MichaelGoberling
left a comment
MichaelGoberling
left a comment
There was a problem hiding this comment.
Approved with the same naming Q as on the JS lib
|
note: I have added the |
The team decided not to go GA yet, so this reverts the previous commit's bump to 1.0.0 and keeps the SDK on a PEP 440 prerelease version, 0.1.0a10, while still removing the user facing alpha warning badge and the now redundant --pre install flag from the docs. Every release of this package has been a prerelease, and pip already resolves the latest prerelease when no stable release exists to fall back to, so dropping --pre does not change install behavior or imply a stable release. Also fixes RELEASING.md so the example version bump command no longer instructs a future releaser to cut a 1.0.0 release. RUNNER-9680
mishamilovidov
changed the title
This has been resolved. See my response here. |
|
note: This PR changed direction from its original intent. It no longer takes the SDK GA. The internal discussions referenced in my note above have settled: we are keeping both this SDK and the JS SDK on prerelease versions rather than cutting a GA release. The open App Builder product questions that motivated the original alpha designation have not fully settled, and both SDKs remain branded and owned by App Builder, so a GA claim would be premature. See this thread on the JS PR for the discussion. What this PR still does:
What it deliberately does not do:
Unlike npm, PyPI has no dist-tag concept, so there is no stale pointer to repair on this side. This change is docs and version only. The GA work moves to a separate effort; we are planning to fork these into a set of Runtime/FaaSt owned SDKs, renamed to something not tied specifically to App Builder, and that fork is what will be shaped as the "sandbox SDK GA". |
5 participants
Changes
0.1.0a9to0.1.0a10. This stays a PEP 440 prerelease, it is not a GA release.--prefrom the install snippet.--prefrom theRELEASING.mdinstall verification step and update the example version bump command.RELEASING.mdnote that claimedpip install aio-lib-sandboxwill not pick up the package without--pre.Related Issues
Notes
--preflag was never required. pip only excludes prereleases when a stable release exists to fall back to, and every version ever published here is a prerelease, so a plainpip install aio-lib-sandboxalready resolves the newest. Verified against pip 23 and pip 26, plain and pinned.RELEASING.mdnote was therefore wrong on its stated reason. Its actual guidance, keep the prerelease suffix until the API is stable, still holds and this PR follows it.